Repository navigation
feat(docs): list the pages a pin move reaches, and review them in the same PR - #25786
Open
alejoamiras wants to merge 3 commits into
Open
alejoamiras wants to merge 3 commits into
alejoamiras wants to merge 3 commits into
Conversation
docs/scripts/pin_doc_references.sh [--line <line>] [<old-commit>] prints `<reference> -> <pages>` for each labs/ reference whose files differ between the line's old and new aztec-node pin. The old commit defaults to the line's pin at the merge base with origin/next. The script fetches it into the line's checkout at depth 1 only when it is missing, and diffs with --no-renames, so a renamed or deleted referenced file is listed too. extract_doc_references.sh gains changed_references, the one matcher (exact file, or a directory prefix ending at a slash). It loses get_unique_references, find_docs_for_reference and build_change_mappings: nothing in the repository calls them (searched every tracked file, including .claude/skills, docs/README.md and the v6 line), and build_change_mappings matched by substring. extract_references_mapping now truncates its output with `: >`: a bare redirection runs `cat` under zsh and blocks on an open stdin.
docs/CLAUDE.md's pin section now tells the agent moving a pin to run scripts/pin_doc_references.sh for each line whose pin moved, update the listed pages with the update-doc-references skill, and check the Node.js minimum the new version installs against node_ver on that line's local-network getting-started page. update-doc-references takes the script's list for a pin move (Step 2), maps a PR with the shared changed_references matcher (Step 3), and keeps a pin move's edits on its own branch and PR (Step 6). release-docs Step 12 and release-network-docs Step 7a list the pages from the destination's pin to the tag and check each one's snapshot copy, since a cut fixes snapshots, never sources. docs/README.md describes the script.
git diff --name-only C-quotes a path holding `"` or `\` even with core.quotePath=false, so its labs/ form matched no reference and the page was silently left out. Read the names NUL-separated instead. The usage text now reads the script by its directory, so it prints from any working directory.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs pages list the aztec-node source files they describe, but nothing told us when those files changed, since aztec-node's PRs don't run our CI. Now, when a PR moves a docs line's aztec-node pin, a script lists the referenced files that changed between the old and new pin and the pages that describe them, and the release skills and pin instructions have the agent moving the pin review those pages in the same PR. Moving the pin also checks the getting-started page's Node.js minimum.